.\"   $Id: modelmbkrds.3,v 1.1 2002/03/13 13:37:37 fred Exp $
.\" @(#)modelmbkrds.1 1.11 93/08/18 ; Labo masi cao-vlsi
.if t \{\
.so man1/alc_contents.mac
.XS \n%
.ti 0.2i
modelmbkrds
.XE
.XS0 \n%
.ti 0.2i
modelmbkrds
.XE0 \}
.TH MODELMBKRDS 3 "October 1, 1997" "ASIM/LIP6" "RDS PHYSICAL FUNCTIONS"
.SH NAME
 modelmbkrds \- gets all models of instances contained in a figure.
.so man1/alc_origin.1
.SH SYNOPSIS
.nf
.if n \{\
.ft B \}
.if t \{\
.ft CR \}
 #include "rfmnnn.h"
rdsfig_list \(**modelmbkrds( Figure, Lynx )
   rdsfig_list \(**Figure;
   char         Lynx;
.ft R
.fi
.SH PARAMETER
.TP 20
\fIFigure\fP :
The figure which has to be treated.
.TP
\fILynx\fP :
Flag used for the segment conversion. If the parameter Lynx is set to 0 then this is the normal conversion mode. If the parameter Lynx is set to 1 then the rds structure generated permits to extract equipotentials rectangles.
.SH DESCRIPTION
The \fImodelmbkrds\fP function gets all models of instances of the RDS figure and chains them to the head of figures's list. For each newly created figure, the function is applied recursively. So the function flats all models contained in the figure named \'Figure\'.
.SH RETURN VALUE
Pointer to the head of the list of figures.
.SH ERRORS
.if n \{\
.ft B \}
.if t \{\
.ft CR \}
"Rds202: rdsalloc error, can't continue !"
.ft R
.RS
it's impossible to allocate the memory size desired
.RE
.PP
Other errors can be generated by the getphfig function called in the modelmbkrds function (see getphfig).
.SH EXAMPLE
.ta 3n 6n 9n 12n 15n 18n 21n
.nf
.if n \{\
.ft B \}
.if t \{\
.ft CR \}
        #include "mphnnn.h"
        #include "mutnnn.h"
        #include "rdsnnn.h"
        #include "rfmnnn.h"
        #include "rtlnnn.h"
        main()
          {
            phfig_list  \(**MbkFigure;
            rdsfig_list \(**RdsFigure;
            rdsfig_list \(**RdsModelList;
            rdsfig_list \(**ScanRdsFigure;
            mbkenv();
            rdsenv();
            loadrdsparam();
            MbkFigure       = getphfig("core",'A');
            RdsFigure       = figmbkrds(MbkFigure,0,1);
            RdsModelList    = \fBmodelmbkrds\fP (RdsFigure,1);
            for ( ScanRdsFigure  = RdsModelList ;
                  ScanRdsFigure != NULL     ;
                  ScanRdsFigure  = ScanRdsFigure->NEXT )
             {
               viewrfmfig ( ScanRdsFigure );
             }
          }
.ft R
.fi
.SH SEE ALSO
.BR librfm,
.BR viewrfmfig,
.BR getphfig,
.BR loadrdsparam


.so man1/alc_bug_report.1

